Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Require Description Resources to be supported #371

Closed
wants to merge 1 commit into from

Conversation

kjetilk
Copy link
Member

@kjetilk kjetilk commented Jan 5, 2022

Currently, there is no server requirement to support describedby resources, only a description about how clients may discover them. I believe this to be a simple omission, it has been in Solid since the dawn of ages, and even though we want to generalize aux resources, this basic functionality should be required in 0.9.x.

There are also tests solid-contrib/specification-tests#65 in this area, and I believe it is appropriate to make this a requirement rather than introduce more variability.

Copy link
Member

@csarven csarven left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I propose PR #372 instead of this PR. It clarifies the actual advertisement of the link relations for auxiliary resources described by the Solid Protocol. It also complements/accompanies #client-link-auxiliary-type.

@@ -753,7 +753,8 @@ <h4 property="schema:name">Web Access Control</h4>
<section id="auxiliary-resources-description-resource" inlist="" rel="schema:hasPart" resource="#auxiliary-resources-description-resource">
<h4 property="schema:name">Description Resource</h4>
<div datatype="rdf:HTML" property="schema:description">
<p>An auxiliary resource of type <em>Description Resource</em> provides a description of a subject resource ([<cite><a class="bibref" href="#bib-ldp">LDP</a></cite>]).</p>
<p>An auxiliary resource of type <em>Description Resource</em> provides a description of a subject resource ([<cite><a class="bibref" href="#bib-ldp">LDP</a></cite>]).
<span about="" id="server-description-required" rel="spec:requirement" resource="#server-description-required"><span property="spec:statement"><span rel="spec:requirementSubject" resource="spec:Server">Servers</span> <span rel="spec:requirementLevel" resource="spec:MUST">MUST</span> support this auxiliary resource type.</span></span></p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And how is it identified? What does supporting it mean?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, this is language pointing at the more generic language in the spec, which also needs work. The rel value is defined in a table, the protocol specific things are there too, the lifecycle assumptions also. I recognize it is in many contexts, including this, a bit problematic to just say "support", but I also tend to think that the tests is a venue to provide authoritative interpretations.

This is mostly to fix the immediate omission that describedby wasn't required in 0.9.

@csarven
Copy link
Member

csarven commented Jan 24, 2022

Updated re #372 . Let's move on.

@csarven csarven closed this Jan 24, 2022
@csarven csarven deleted the fix/require-describedby branch May 12, 2022 16:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants